home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / admin.z / admin
Text File  |  1998-10-20  |  19KB  |  397 lines

  1.  
  2.  
  3.  
  4. aaaaddddmmmmiiiinnnn((((1111))))                                                              aaaaddddmmmmiiiinnnn((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      admin - create and administer SCCS files
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      aaaaddddmmmmiiiinnnn [----nnnn] [----iiii[name]] [----rrrr rel] [----tttt[name]] [----ffff flag[flag-val]][----dddd flag[flag-val]] [----aaaa login] [----eeee login] [----mmmm mmmmrrrrlllliiiisssstttt]]]] [[[[----yyyy[comment]] [----hhhh] [----zzzz] files
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      _a_d_m_i_n is used to create new SCCS files and change parameters of existing
  16.      ones.  Arguments to _a_d_m_i_n, which may appear in any order, consist of
  17.      keyletter arguments, which begin with ----, and named files (note that SCCS
  18.      filenames must begin with the characters ssss....).  If a named file does not
  19.      exist, it is created and its parameters are initialized according to the
  20.      specified keyletter arguments.  Parameters not initialized by a keyletter
  21.      argument are assigned a default value.  If a named file does exist,
  22.      parameters corresponding to specified keyletter arguments are changed and
  23.      other parameters are left as is.
  24.  
  25.      If a directory is named, _a_d_m_i_n behaves as though each file in the
  26.      directory were specified as a named file, except that non-SCCS files
  27.      (last component of the pathname does not begin with ssss....)  and unreadable
  28.      files are silently ignored.  If a name of ---- is given, the standard input
  29.      is read; each line of the standard input is taken to be the name of an
  30.      SCCS file to be processed.  Again, non-SCCS files and unreadable files
  31.      are silently ignored.
  32.  
  33. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  34.      The keyletter arguments are as follows.  Each is explained as though only
  35.      one named file is to be processed because the effects of the arguments
  36.      apply independently to each named file.
  37.  
  38.           ----nnnn             This keyletter indicates that a new SCCS file is to
  39.                          be created.
  40.  
  41.           ----iiii[_n_a_m_e]       The _n_a_m_e of a file from which the text for a new SCCS
  42.                          file is to be taken.  The text constitutes the first
  43.                          delta of the file (see ----rrrr keyletter for delta
  44.                          numbering scheme).  If the iiii keyletter is used but
  45.                          the filename is omitted, the text is obtained by
  46.                          reading the standard input until an end of Rused,file
  47.                          is encountered.  If this keyletter is omitted, then
  48.                          the SCCS file is created empty.  Only one SCCS file
  49.                          may be created by an _a_d_m_i_n command on which the iiii
  50.                          keyletter is supplied.  Using a single _a_d_m_i_n to
  51.                          create two or more SCCS files requires that they be
  52.                          created empty (no ----iiii keyletter).  Note that the ----iiii
  53.                          keyletter implies the ----nnnn keyletter.
  54.  
  55.           ----rrrr_r_e_l          The _r_e_lease into which the initial delta is inserted.
  56.                          If the ----rrrr keyletter is not used, the initial delta is
  57.                          inserted into release 1.  The level of the initial
  58.                          delta is always 1 (by default initial deltas are
  59.                          named 1.1).
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaaddddmmmmiiiinnnn((((1111))))                                                              aaaaddddmmmmiiiinnnn((((1111))))
  71.  
  72.  
  73.  
  74.           ----tttt[_n_a_m_e]       The _n_a_m_e of a file from which descriptive text for
  75.                          the SCCS file is to be taken.  If the ----tttt keyletter is
  76.                          used and _a_d_m_i_n is creating a new SCCS file (the ----nnnn
  77.                          and/or ----iiii keyletters also used), the descriptive text
  78.                          filename must also be supplied.  In the case of
  79.                          existing SCCS filesSflag ((((1111)))) aaaa ----tttt keyletter without a
  80.                          filename causes removal of descriptive text (if any)
  81.                          currently in the SCCS file, and (2) a ----tttt keyletter
  82.                          with a filename causes text (if any) in the named
  83.                          file to replace the descriptive text (if any)
  84.                          currently in the SCCS file.
  85.  
  86.           ----ffff_f_l_a_g         This keyletter specifies a _f_l_a_g and, possibly, a
  87.                          value for the _f_l_a_g to be placed in the SCCS file.
  88.                          Several ffff keyletters may be supplied on a single
  89.                          _a_d_m_i_n command line.  The allowable _f_l_a_gs and their
  90.                          values are
  91.  
  92.                bbbb         Allows use of the ----bbbb keyletter on a _g_e_t(1) command to
  93.                          create branch deltas.
  94.  
  95.                cccc_c_e_i_l     The highest release (i.e., ``ceiling''), a number
  96.                          greater than 0 but less than or equal to 9999, that
  97.                          can be retrieved by a _g_e_t(1) command for editing.
  98.                          The default value for an unspecified cccc flag is 9999.
  99.  
  100.                ffff_f_l_o_o_r    The lowest release (i.e., ``floor''), a number
  101.                          greater than 0 but less than 9999, that can be
  102.                          retrieved by a _g_e_t(1) command for editing.  The
  103.                          default value for an unspecified ffff flag is 1.
  104.  
  105.                dddd_S_I_D      The default delta number (SIDs+1) used by a _g_e_t(1)
  106.                          command.
  107.  
  108.                iiii[_s_t_r]    Causes the "No id keywords (ge6)" message issued by
  109.                          _g_e_t(1) or _d_e_l_t_a(1) to be treated as a fatal error.
  110.                          In the absence of this flag, the message is only a
  111.                          warning.  The message is issued if no SCCS
  112.                          identification keywords (see _g_e_t(1)) are found in the
  113.                          text retrieved or stored in the SCCS file.  If a
  114.                          value is supplied, the keywords must match the given
  115.                          string exactly; however, the string must contain a
  116.                          keyword and no embedded newlines.
  117.  
  118.                jjjj         Allows concurrent _g_e_t(1) commands for editing on the
  119.                          same SIDs+1 of an SCCS file.  This allows multiple
  120.                          concurrent updates to the same version of the SCCS
  121.                          file.
  122.  
  123.                llll_l_i_s_t     A _l_i_s_t of releases to which deltas can no longer be
  124.                          made (ggggeeeetttt ----eeee against one of these ``locked'' releases
  125.                          fails).  The _l_i_s_t has the following syntax:
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. aaaaddddmmmmiiiinnnn((((1111))))                                                              aaaaddddmmmmiiiinnnn((((1111))))
  137.  
  138.  
  139.  
  140.                <list>    ::= <range> | <list> , <range>
  141.                          <range>~::=    _R_E_L_E_A_S_E _N_U_M_B_E_R | aaaa
  142.  
  143.                          The character aaaa in the _l_i_s_t is equivalent to
  144.                          specifying _a_l_l _r_e_l_e_a_s_e_s for the named SCCS file.
  145.  
  146.                nnnn         Causes _d_e_l_t_a(1) to create a null delta in each of
  147.                          those releases (if any) being skipped when a delta is
  148.                          made in a _n_e_w release (e.g., in making delta 5.1
  149.                          after delta 2.7, releases 3 and 4 are skipped).
  150.                          These null deltas serve as anchor points that branch
  151.                          deltas may later be created from.  The absence of
  152.                          this flag causes skipped releases to be nonexistent
  153.                          in the SCCS file, preventing branch deltas from being
  154.                          created from them in the future.
  155.  
  156.                qqqq_t_e_x_t     User definable text substituted for all occurrences
  157.                          of the %Q% keyword in the SCCS file text retrieved by
  158.                          _g_e_t(1).
  159.  
  160.                mmmm_m_o_d      _M_o_dule name of the SCCS file substituted for all
  161.                          occurrences of the %M% keyword in the SCCS file text
  162.                          retrieved by _g_e_t(1).  If the mmmm flag is not specified,
  163.                          the value assigned is the name of the SCCS file with
  164.                          the leading ssss.... removed.
  165.  
  166.                tttt_t_y_p_e     _T_y_p_e of module in the SCCS file substituted for all
  167.                          occurrences of %Y% keyword in the SCCS file text
  168.                          retrieved by _g_e_t(1).
  169.  
  170.                vvvv_p_g_m      Causes _d_e_l_t_a(1) to prompt for Modification Request
  171.                          (MR) numbers as the reason for creating a delta.  The
  172.                          optional value specifies the name of an MR number
  173.                          validity checking program (see _d_e_l_t_a(1)).  (If this
  174.                          flag is set when creating an SCCS file, the mmmm
  175.                          keyletter must also be used even if its value is
  176.                          null.)
  177.  
  178.           ----dddd_f_l_a_g         Causes removal (deletion) of the specified _f_l_a_g from
  179.                          an SCCS file.  The ----dddd keyletter may be specified only
  180.                          when processing existing SCCS files.  Several ----dddd
  181.                          keyletters may be supplied on a single _a_d_m_i_n command.
  182.                          See the ----ffff keyletter for allowable _f_l_a_g names.
  183.  
  184.                llll_l_i_s_t     A _l_i_s_t of releases to be ``unlocked.''  See the ----ffff
  185.                          keyletter for a description of the llll flag and the
  186.                          syntax of a _l_i_s_t.
  187.  
  188.           ----aaaa_l_o_g_i_n        A _l_o_g_i_n name, or numeric UNIX system group ID, to be
  189.                          added to the list of users that
  190.                           make deltas (changes) to the SCCS file.  A group ID
  191.                          is equivalent to specifying all _l_o_g_i_n names common to
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. aaaaddddmmmmiiiinnnn((((1111))))                                                              aaaaddddmmmmiiiinnnn((((1111))))
  203.  
  204.  
  205.  
  206.                          that group ID.  Several aaaa keyletters may be used on a
  207.                          single _a_d_m_i_n command line.  As many _l_o_g_i_ns, or
  208.                          numeric group ID's as desired may be on the list
  209.                          simultaneously.  If the list of users is empty, then
  210.                          anyone may add deltas.  If a _l_o_g_i_n or group ID is
  211.                          preceded by a !!!! they are do not have permission to
  212.                          make deltas.
  213.  
  214.           ----eeee_l_o_g_i_n        A _l_o_g_i_n name, or numeric group ID, to be erased from
  215.                          the list of users allowed to make deltas (changes) to
  216.                          the SCCS file.  Specifying a group ID is equivalent
  217.                          to specifying all _l_o_g_i_n names common to that group
  218.                          ID.  Several eeee keyletters may be used on a single
  219.                          _a_d_m_i_n command line.
  220.  
  221.           ----mmmm[_m_r_l_i_s_t]     The list of Modification Requests (MR) numbers is
  222.                          inserted into the SCCS file as the reason for
  223.                          creating the initial delta in a manner identical to
  224.                          _d_e_l_t_a(1).  The vvvv flag must be set and the MR numbers
  225.                          validated if the vvvv flag has a value (the name of an
  226.                          MR number validation program).  Diagnostics will
  227.                          occur if the vvvv flag is not set or if MR validation
  228.                          fails.
  229.  
  230.           ----yyyy[_c_o_m_m_e_n_t]    The _c_o_m_m_e_n_t text is inserted into the SCCS file as a
  231.                          comment for the initial delta in a manner identical
  232.                          to that of _d_e_l_t_a(1).  Omissing the ----yyyy keyletter
  233.                          results in a default comment line being inserted in
  234.                          the form
  235.  
  236.                          date and time created _Y_Y/_M_M/_D_D _H_H:_M_M:_S_S by _l_o_g_i_n
  237.  
  238.                          The ----yyyy keyletter is valid only if the ----iiii and/or ----nnnn
  239.                          keyletters are specified (that is, a new SCCS file is
  240.                          being created).
  241.  
  242.           ----hhhh             Causes _a_d_m_i_n to check the structure of the SCCS file
  243.                          (see _s_c_c_s_f_i_l_e(5)) and to compare a newly computed
  244.                          check-sum (the sum of all the characters in the SCCS
  245.                          file except those in the first line) with the check-
  246.                          sum that is stored in the first line of the SCCS
  247.                          file.  Appropriate error diagnostics are produced.
  248.  
  249.                          This keyletter inhibits writing on the file,
  250.                          nullifying the effect of any other keyletters
  251.                          supplied, and is, therefore, only meaningful when
  252.                          processing existing files.
  253.  
  254.           ----zzzz             The SCCS file check-sum is recomputed and stored in
  255.                          the first line of the SCCS file (see ----hhhh, above).
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. aaaaddddmmmmiiiinnnn((((1111))))                                                              aaaaddddmmmmiiiinnnn((((1111))))
  269.  
  270.  
  271.  
  272.                          Note that using this keyletter on a truly corrupted
  273.                          file may prevent future detection of the corruption.
  274.  
  275.           The last component of all SCCS filenames must be of the form
  276.           ssss...._f_i_l_e_n_a_m_e.  New SCCS files are given mode 444 (see _c_h_m_o_d(1)).
  277.           Write permission in the pertinent directory is, of course, required
  278.           to create a file.  All writing done by _a_d_m_i_n is to a temporary x-
  279.           file, called xxxx...._f_i_l_e_n_a_m_e (see _g_e_t(1)), created with mode 444 if the
  280.           _a_d_m_i_n command is creating a new SCCS file or with the same mode as
  281.           the SCCS file if it exists.  After the successful execution of
  282.           _a_d_m_i_n, the SCCS file is removed (if it exists) and the x-file is
  283.           renamed with the name of the SCCS file.  This ensures that changes
  284.           are made to the SCCS file only if no errors occurred.
  285.  
  286.           It is recommended that directories containing SCCS files be mode 755
  287.           and that SCCS files themselves be mode 444.  The mode of the
  288.           directories allows only the owner to modify SCCS files contained in
  289.           the directories.  The mode of the SCCS files prevents any
  290.           modification at all except by SCCS commands.
  291.  
  292.           If it should be necessary to patch an SCCS file for any reason, the
  293.           mode may be changed to 644 by the owner allowing the use of _e_d(1).
  294.           _C_a_r_e _m_u_s_t _b_e _t_a_k_e_n! The edited file should _a_l_w_a_y_s be processed by an
  295.           _a_d_m_i_n ----hhhh to check for corruption, followed by an _a_d_m_i_n ----zzzz to
  296.           generate a proper check-sum.  Another _a_d_m_i_n ----hhhh is recommended to
  297.           ensure the SCCS file is valid.
  298.  
  299.           _a_d_m_i_n also makes use of a transient lock file (called zzzz...._f_i_l_e_n_a_m_e),
  300.           to prevent simultaneous updates to the SCCS file by different users.
  301.           See _g_e_t(1) for further information.
  302.  
  303. FFFFIIIILLLLEEEESSSS
  304.      g-file           Existed before the execution of _d_e_l_t_a; removed after
  305.                       completion of _d_e_l_t_a.
  306.      p-file           Existed before the execution of _d_e_l_t_a; may exist after
  307.                       completion of _d_e_l_t_a.
  308.      q-file           Created during the execution of _d_e_l_t_a; removed after
  309.                       completion of _d_e_l_t_a.
  310.      x-file           Created during the execution of _d_e_l_t_a; renamed to SCCS
  311.                       file after completion of _d_e_l_t_a.
  312.      z-file           Created during the execution of _d_e_l_t_a; removed during
  313.                       the execution of _d_e_l_t_a.
  314.      d-file           Created during the execution of _d_e_l_t_a; removed after
  315.                       completion of _d_e_l_t_a.
  316.      /usr/bin/bdiff   Program to compute differences between the ``gotten''
  317.                       file and the _g-_f_i_l_e.
  318.  
  319. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  320.      delta(1), ed(1), get(1), help(1), prs(1), what(1), sccsfile(4).
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. aaaaddddmmmmiiiinnnn((((1111))))                                                              aaaaddddmmmmiiiinnnn((((1111))))
  335.  
  336.  
  337.  
  338. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  339.      Use _h_e_l_p(1) for explanations.
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.